/*
 * Copyright 2017-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.cassandra.core.mapping;

/**
 * Interface that entity classes may choose to implement in order to allow a client of the entity to easily get the
 * entity's {@link MapId}.
 *
 * @author Matthew T. Adams
 */
public interface MapIdentifiable {

	/**
	 * Gets the identity of this instance. Throws {@link IllegalStateException} if this instance does not use
	 * {@link MapId}.
	 */
	MapId getMapId();
}
